package cn.dakaqi.web.apidoc;

/**
 * Created by chunyang on 2016/5/8.
 */
@Deprecated
public interface AccountDoc
{

    /**
     * @api {get} /account/register/sendCode/:mobile 手机注册时获取验证码
     * @apiName 手机注册时获取验证码
     * @apiGroup Account
     * @apiVersion 0.0.1
     * @apiDescription 手机注册时获取验证码
     *
     * @apiParam {String} mobile 手机号码
     *
     * @apiSuccess {String} code 结果码 (0成功 1异常 2暂无数据)
     * @apiSuccess {String} msg 消息说明
     * @apiSuccessExample Success-Response:
     *  HTTP/1.1 200 OK
     * {
     * code:0,
     * msg:'success',
     * data:{}
     *  }
     *
     *  @apiError Account 对应<code>id</code>的用户没找到 asdfasdf
     *  @apiErrorExample {json} Error-Response:
     *  HTTP/1.1 404 Not Found
     *  {
     *   code:1,
     *   msg:'user not found',
     *   }
     *
     * @return
     * @throws Exception
     */
    public void register();



    /**
     *
     * @api {get} /account/findpasswd/sendCode/:mobile 找回密码时获取验证码
     * @apiName 找回密码时获取验证码1
     * @apiGroup Account
     * @apiVersion 0.0.1
     * @apiDescription 找回密码时获取验证码
     *
     * @apiParam {String} mobile 手机号码
     *
     * @apiSuccess {String} code 结果码 (0成功 1异常 2暂无数据)
     * @apiSuccess {String} msg 消息说明
     * @apiSuccessExample Success-Response:
     *  HTTP/1.1 200 OK
     * {
     * code:0,
     * msg:'success',
     * data:{}
     *  }
     *
     *  @apiError Account 对应<code>id</code>的用户没找到 asdfasdf
     *  @apiErrorExample {json} Error-Response:
     *  HTTP/1.1 404 Not Found
     *  {
     *   code:1,
     *   msg:'user not found',
     *   }
     *
     * @return
     * @throws Exception
     */
    public void findpasswd();


    /**
     *
     * @api {post} /account/create 新用户注册
     * @apiName 新用户注册2
     * @apiGroup Account
     * @apiVersion 0.0.1
     * @apiDescription 新用户注册
     *
     * @apiParam {String} mobile 手机号码
     * @apiParam {String} password 密码
     * @apiParam {String} platform 0/android 1/ios 2/web
     * @apiParam {String} code 手机验证码
     *
     * @apiSuccess {String} code 结果码 (0成功 1异常 2暂无数据)
     * @apiSuccess {String} msg 消息说明
     * @apiSuccessExample Success-Response:
     *  HTTP/1.1 200 OK
     * {
     * code:0,
     * msg:'success',
     * data:{}
     *  }
     *
     *  @apiError Account 对应<code>id</code>的用户没找到 asdfasdf
     *  @apiErrorExample {json} Error-Response:
     *  HTTP/1.1 404 Not Found
     *  {
     *   code:1,
     *   msg:'user not found',
     *   }
     *
     * @return
     * @throws Exception
     */
    public void create();

    /**
     *
     * @api {post} /account/login 用户登录
     * @apiName 用户登录
     * @apiGroup Account
     * @apiVersion 0.0.1
     * @apiDescription 用户登录
     * @apiHeaderExample {json} Header-Example:
     *     {
     *       "Content-Type": "application/json; charset=utf-8",
     *       "dataType":"json",
     *     }
     * @apiHeader {String} Content-Type application/json; charset=utf-8
     * @apiHeader {String} dataType json
     * @apiHeader {String} Accept application/json
     *
     * @apiParamExample {json} 事例
     * {
     *      "mobile": "15821117932"
     *      "password": "123456"
     * }
     * @apiParam {String} mobile
     * @apiParam {string} password
     * @apiSuccess {String} code 结果码 (0成功 1异常 2暂无数据)
     * @apiSuccess {String} msg 消息说明
     * @apiSuccessExample Success-Response:
     *  HTTP/1.1 200 OK
     * {
     * code:0,
     * msg:'success',
     * data:{}
     *  }
     *
     *  @apiError Account 对应<code>id</code>的用户没找到 asdfasdf
     *  @apiErrorExample {json} Error-Response:
     *  HTTP/1.1 404 Not Found
     *  {
     *   code:1,
     *   msg:'user not found',
     *   }
     *
     * @return
     * @throws Exception
     */
    public void login();
}
